//
//  OLLocrAPIContext.h
//
// Copyright (c) 2009 Houdah Software s.à r.l. (http://www.houdah.com)
// Copyright (c) 2009 Lukhnos D. Liu (http://lukhnos.org)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//

#import <Foundation/Foundation.h>

#import "LFWebAPIKit.h"
#import "OLUtilities.h"
#import "OLXMLMapper.h"


extern NSString *const OLLocrThumbnailSize;			// 100x75
extern NSString *const OLLocrSquareSize;			// 100x100
extern NSString *const OLLocrSmallSize;				// 240x180
extern NSString *const OLLocrMediumSize;			// 500x375
extern NSString *const OLLocrLargeSize;				// 1024x768
extern NSString *const OLLocrOriginalSize;			// (no size modifier)


@protocol OLLocrAPISignatureConsumer;

@interface OLLocrAPIContext : NSObject
{
	LFHTTPRequest *httpRequest;

	NSString *userName;
    NSString *password;
    
    NSString *queryEndpoint;
    NSString *signatureEndpoint;
    NSString *uploadEndpoint;
}

- (id)initWithUserName:(NSString *)inUserName password:(NSString *)inPassword;

- (NSString*)userName;
- (NSString*)password;


// URL provisioning
+ (NSURL *)photoSourceURLFromDictionary:(NSDictionary *)inDictionary size:(NSString *)inSizeModifier;
+ (NSURL *)photoWebPageURLFromDictionary:(NSDictionary *)inDictionary;

// API endpoints
- (void)setQueryEndpoint:(NSString *)inEndpoint;
- (NSString *)queryEndpoint;

- (void)setSignatureEndpoint:(NSString *)inEndpoint;
- (NSString *)signatureEndpoint;

- (void)setUploadEndpoint:(NSString *)inEndpoint;
- (NSString *)uploadEndpoint;

#if MAC_OS_X_VERSION_MIN_REQUIRED > MAC_OS_X_VERSION_10_4
@property (nonatomic, readonly) NSString *userName;
@property (nonatomic, readonly) NSString *password;

@property (nonatomic, retain) NSString *queryEndpoint;
@property (nonatomic, retain) NSString *signatureEndpoint;
@property (nonatomic, retain) NSString *uploadEndpoint;
#endif

- (BOOL)requestSignature:(id<OLLocrAPISignatureConsumer>)signatureConsumer;

@end


@protocol OLLocrAPISignatureConsumer

- (void)context:(OLLocrAPIContext*)inContext providesSignature:(NSString*)inSignature;
- (void)context:(OLLocrAPIContext*)inContext failedToProvideSignatureWithError:(NSError*)inError;

@end